/*
 * MIT License
 *
 * Copyright (c) 2020 Mr.css
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package cn.seaboot.postman.response.analyzer;

import cn.seaboot.postman.PostmanConfiguration;
import cn.seaboot.postman.analyzer.MethodInfo;
import cn.seaboot.postman.response.BodyField;
import cn.seaboot.postman.response.Response;
import org.jetbrains.annotations.Nullable;

/**
 * 扫描Controller返回值，获取到Response的样例数据
 * <p>
 * Analyze method' return-value and return {@link BodyField},
 * the {@link BodyField} will be used for generate {@link Response};
 *
 * @author Mr.css
 * @date 2021-01-31 14:29
 */
public interface BodyFieldAnalyzer {

    /**
     * return the method-return description.
     *
     * @param configuration configuration
     * @param method        method
     * @return description of return-type
     */
    @Nullable BodyField analyzeBodyField(PostmanConfiguration configuration, MethodInfo method);
}
